<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>run_lyx &mdash; GSLab Make 2.0.0 documentation</title>
      <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="../../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
        <script src="../../../_static/jquery.js"></script>
        <script src="../../../_static/underscore.js"></script>
        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../../../_static/doctools.js"></script>
        <script src="../../../_static/sphinx_highlight.js"></script>
    <script src="../../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
    <link rel="next" title="run_mathematica" href="gslab_make.run_program.run_mathematica.html" />
    <link rel="prev" title="run_latex" href="gslab_make.run_program.run_latex.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../../../index.html" class="icon icon-home">
            GSLab Make
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../specifying_paths.html">Specifying paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../general_logging.html">General logging functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../sourcing.html">Sourcing functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../source_logging.html">Source logging functions</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../program.html">Program functions</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../program.html#default-settings">Default settings</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../program.html#supported-applications">Supported applications</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.execute_command.html">execute_command</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_jupyter.html">run_jupyter</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_latex.html">run_latex</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">run_lyx</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gslab_make.run_program.run_lyx"><code class="docutils literal notranslate"><span class="pre">run_lyx()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_mathematica.html">run_mathematica</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_matlab.html">run_matlab</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_module.html">run_module</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_perl.html">run_perl</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_python.html">run_python</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_r.html">run_r</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_sas.html">run_sas</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_stat_transfer.html">run_stat_transfer</a></li>
<li class="toctree-l3"><a class="reference internal" href="gslab_make.run_program.run_stata.html">run_stata</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utility.html">Utility functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../repository.html">Repository functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../directory.html">Directory functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../filling.html">Filling functions</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">GSLab Make</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../../program.html">Program functions</a></li>
      <li class="breadcrumb-item active">run_lyx</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../../../_sources/pages/api/run_program/gslab_make.run_program.run_lyx.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="run-lyx">
<h1>run_lyx<a class="headerlink" href="#run-lyx" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="gslab_make.run_program.run_lyx">
<span class="sig-name descname"><span class="pre">run_lyx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">paths</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">program</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doctype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gslab_make.run_program.run_lyx" title="Permalink to this definition"></a></dt>
<dd><p>Compiles document <code class="docutils literal notranslate"><span class="pre">program</span></code> using system command, with document specified
in the form of <code class="docutils literal notranslate"><span class="pre">script.lyx</span></code>. Status messages are appended to file <code class="docutils literal notranslate"><span class="pre">makelog</span></code>.
PDF outputs are written in directory <code class="docutils literal notranslate"><span class="pre">output_dir</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>paths</strong> (<em>dict</em>) – Dictionary of paths. Dictionary should contain values for all keys listed below.</p></li>
<li><p><strong>program</strong> (<em>str</em>) – Path of script to run.</p></li>
<li><p><strong>doctype</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of LyX document. Takes either <code class="docutils literal notranslate"><span class="pre">'handout'</span></code> and <code class="docutils literal notranslate"><span class="pre">'comments'</span></code>.
All other strings will default to standard document type.
Defaults to <code class="docutils literal notranslate"><span class="pre">''</span></code> (i.e., standard document type).</p></li>
</ul>
</dd>
<dt class="field-even">Path Keys<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>makelog</strong> (<em>str</em>) – Path of makelog.</p></li>
<li><p><strong>output_dir</strong> (<em>str</em>) – Directory to write PDFs.</p></li>
</ul>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>We recommend leaving all other parameters to their defaults.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>osname</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of OS. Used to determine syntax of system command. Defaults to <code class="docutils literal notranslate"><span class="pre">os.name</span></code>.</p></li>
<li><p><strong>shell</strong> (<cite>bool</cite>, optional) – See <a class="reference external" href="https://docs.python.org/3/library/subprocess.html#frequently-used-arguments">here</a>.
Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
<li><p><strong>log</strong> (<em>str</em><em>, </em><em>optional</em>) – Path of program log. Program log is only written if specified.
Defaults to <code class="docutils literal notranslate"><span class="pre">''</span></code> (i.e., not written).</p></li>
<li><p><strong>executable</strong> (<em>str</em><em>, </em><em>optional</em>) – Executable to use for system command.
Defaults to executable specified in <a class="reference internal" href="../../program.html#default-settings"><span class="std std-ref">default settings</span></a>.</p></li>
<li><p><strong>option</strong> (<em>str</em><em>, </em><em>optional</em>) – Options for system command. Defaults to options specified in <a class="reference internal" href="../../program.html#default-settings"><span class="std std-ref">default settings</span></a>.</p></li>
<li><p><strong>args</strong> (<em>str</em><em>, </em><em>optional</em>) – Not applicable.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
<p class="rubric">Example</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">run_lyx</span><span class="p">(</span><span class="n">paths</span><span class="p">,</span> <span class="n">program</span> <span class="o">=</span> <span class="s1">&#39;script.lyx&#39;</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="gslab_make.run_program.run_latex.html" class="btn btn-neutral float-left" title="run_latex" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="gslab_make.run_program.run_mathematica.html" class="btn btn-neutral float-right" title="run_mathematica" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2023, Matthew Gentzkow.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>